<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimp: GIMP 3 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP 3 Library Reference Manual">
<link rel="up" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="prev" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="next" href="libgimp3-gimpenums.html" title="gimpenums">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libgimp3-Gimp.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimp-general.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimp-general.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimp3-gimpenums.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp3-Gimp"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp3-Gimp.top_of_page"></a>gimp</span></h2>
<p>gimp — Main functions needed for building a GIMP plug-in.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp3-Gimp.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#GIMP-MAIN:CAPS" title="GIMP_MAIN()">GIMP_MAIN</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-main" title="gimp_main ()">gimp_main</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GimpPlugIn.html" title="GimpPlugIn"><span class="returnvalue">GimpPlugIn</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-get-plug-in" title="gimp_get_plug_in ()">gimp_get_plug_in</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GimpPDB.html" title="GimpPDB"><span class="returnvalue">GimpPDB</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-get-pdb" title="gimp_get_pdb ()">gimp_get_pdb</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-quit" title="gimp_quit ()">gimp_quit</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-tile-width" title="gimp_tile_width ()">gimp_tile_width</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-tile-height" title="gimp_tile_height ()">gimp_tile_height</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-show-help-button" title="gimp_show_help_button ()">gimp_show_help_button</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-export-color-profile" title="gimp_export_color_profile ()">gimp_export_color_profile</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-export-comment" title="gimp_export_comment ()">gimp_export_comment</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-export-exif" title="gimp_export_exif ()">gimp_export_exif</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-export-xmp" title="gimp_export_xmp ()">gimp_export_xmp</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-export-iptc" title="gimp_export_iptc ()">gimp_export_iptc</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../html/libgimpbase3-gimpbaseenums.html#GimpCheckSize"><span class="returnvalue">GimpCheckSize</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-check-size" title="gimp_check_size ()">gimp_check_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../html/libgimpbase3-gimpbaseenums.html#GimpCheckType"><span class="returnvalue">GimpCheckType</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-check-type" title="gimp_check_type ()">gimp_check_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GimpDisplay.html" title="gimpdisplay"><span class="returnvalue">GimpDisplay</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-default-display" title="gimp_default_display ()">gimp_default_display</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-wm-class" title="gimp_wm_class ()">gimp_wm_class</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-display-name" title="gimp_display_name ()">gimp_display_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-monitor-number" title="gimp_monitor_number ()">gimp_monitor_number</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint32</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-user-time" title="gimp_user_time ()">gimp_user_time</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-icon-theme-dir" title="gimp_icon_theme_dir ()">gimp_icon_theme_dir</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-get-progname" title="gimp_get_progname ()">gimp_get_progname</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-version" title="gimp_version ()">gimp_version</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-getpid" title="gimp_getpid ()">gimp_getpid</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-attach-parasite" title="gimp_attach_parasite ()">gimp_attach_parasite</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-detach-parasite" title="gimp_detach_parasite ()">gimp_detach_parasite</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-GimpParasite.html#GimpParasite"><span class="returnvalue">GimpParasite</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-get-parasite" title="gimp_get_parasite ()">gimp_get_parasite</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> **
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-get-parasite-list" title="gimp_get_parasite_list ()">gimp_get_parasite_list</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GFile</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-Gimp.html#gimp-temp-file" title="gimp_temp_file ()">gimp_temp_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp3-Gimp.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgimp3-Gimp.html#gimp-get-data" title="gimp_get_data">gimp_get_data</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgimp3-Gimp.html#gimp-get-data-size" title="gimp_get_data_size">gimp_get_data_size</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgimp3-Gimp.html#gimp-set-data" title="gimp_set_data">gimp_set_data</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="libgimp3-Gimp.html#GimpPixbufTransparency" title="enum GimpPixbufTransparency">GimpPixbufTransparency</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp3-Gimp.description"></a><h2>Description</h2>
<p>Main functions needed for building a GIMP plug-in.
This header includes all other GIMP Library headers.</p>
<p>Also contains some miscellaneous procedures that don't fit in any
other category.</p>
</div>
<div class="refsect1">
<a name="libgimp3-Gimp.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GIMP-MAIN:CAPS"></a><h3>GIMP_MAIN()</h3>
<pre class="programlisting">#define             GIMP_MAIN(plug_in_type)</pre>
<p>A macro that expands to the appropriate <code class="function">main()</code> function for the
platform being compiled for.</p>
<p>To use this macro, simply place a line that contains just the code</p>
<p>GIMP_MAIN (MY_TYPE_PLUG_IN)</p>
<p>at the toplevel of your file. No semicolon should be used.</p>
<div class="refsect3">
<a name="GIMP-MAIN.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>plug_in_type</p></td>
<td class="parameter_description"><p>The <span class="type">GType</span> of the plug-in's <a class="link" href="GimpPlugIn.html" title="GimpPlugIn"><span class="type">GimpPlugIn</span></a> subclass</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-main"></a><h3>gimp_main ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
gimp_main (<em class="parameter"><code><span class="type">GType</span> plug_in_type</code></em>,
           <em class="parameter"><code><span class="type">gint</span> argc</code></em>,
           <em class="parameter"><code><span class="type">gchar</span> *argv[]</code></em>);</pre>
<p>The main plug-in function that must be called with the plug-in's
<a class="link" href="GimpPlugIn.html" title="GimpPlugIn"><span class="type">GimpPlugIn</span></a> subclass <span class="type">GType</span> and the 'argc' and 'argv' that are passed
to the platform's <code class="function">main()</code>.</p>
<p>See also: <a class="link" href="libgimp3-Gimp.html#GIMP-MAIN:CAPS" title="GIMP_MAIN()"><code class="function">GIMP_MAIN()</code></a>, <a class="link" href="GimpPlugIn.html" title="GimpPlugIn"><span class="type">GimpPlugIn</span></a>.</p>
<div class="refsect3">
<a name="gimp-main.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>plug_in_type</p></td>
<td class="parameter_description"><p>the type of the <a class="link" href="GimpPlugIn.html" title="GimpPlugIn"><span class="type">GimpPlugIn</span></a> subclass of the plug-in</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>argc</p></td>
<td class="parameter_description"><p>the number of arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>argv</p></td>
<td class="parameter_description"><p>the arguments. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=argc]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-main.returns"></a><h4>Returns</h4>
<p> an exit status as defined by the C library,
on success EXIT_SUCCESS.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-get-plug-in"></a><h3>gimp_get_plug_in ()</h3>
<pre class="programlisting"><a class="link" href="GimpPlugIn.html" title="GimpPlugIn"><span class="returnvalue">GimpPlugIn</span></a> *
gimp_get_plug_in (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>This function returns the plug-in's <a class="link" href="GimpPlugIn.html" title="GimpPlugIn"><span class="type">GimpPlugIn</span></a> instance, which is
a a singleton that can exist exactly once per running plug-in.</p>
<div class="refsect3">
<a name="gimp-get-plug-in.returns"></a><h4>Returns</h4>
<p>The plug-in's <a class="link" href="GimpPlugIn.html" title="GimpPlugIn"><span class="type">GimpPlugIn</span></a> singleton. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-get-pdb"></a><h3>gimp_get_pdb ()</h3>
<pre class="programlisting"><a class="link" href="GimpPDB.html" title="GimpPDB"><span class="returnvalue">GimpPDB</span></a> *
gimp_get_pdb (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>This function returns the plug-in's <a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> instance, which is a
singleton that can exist exactly once per running plug-in.</p>
<div class="refsect3">
<a name="gimp-get-pdb.returns"></a><h4>Returns</h4>
<p>The plug-in's <a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> singleton. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-quit"></a><h3>gimp_quit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_quit (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Forcefully causes the GIMP library to exit and close down its
connection to main gimp application. This function never returns.</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-tile-width"></a><h3>gimp_tile_width ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
gimp_tile_width (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the tile width GIMP is using.</p>
<p>This is a constant value given at plug-in configuration time.</p>
<div class="refsect3">
<a name="gimp-tile-width.returns"></a><h4>Returns</h4>
<p> the tile_width</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-tile-height"></a><h3>gimp_tile_height ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
gimp_tile_height (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the tile height GIMP is using.</p>
<p>This is a constant value given at plug-in configuration time.</p>
<div class="refsect3">
<a name="gimp-tile-height.returns"></a><h4>Returns</h4>
<p> the tile_height</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-show-help-button"></a><h3>gimp_show_help_button ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_show_help_button (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns whether or not GimpDialog should automatically add a help
button if help_func and help_id are given.</p>
<p>This is a constant value given at plug-in configuration time.</p>
<div class="refsect3">
<a name="gimp-show-help-button.returns"></a><h4>Returns</h4>
<p> the show_help_button boolean</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-export-color-profile"></a><h3>gimp_export_color_profile ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_export_color_profile (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns whether file plug-ins should default to exporting the
image's color profile.</p>
<div class="refsect3">
<a name="gimp-export-color-profile.returns"></a><h4>Returns</h4>
<p> TRUE if preferences are set to export the color profile.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-10-4.html#api-index-2.10.4">2.10.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-export-comment"></a><h3>gimp_export_comment ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_export_comment (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns whether file plug-ins should default to exporting the
image's comment.</p>
<div class="refsect3">
<a name="gimp-export-comment.returns"></a><h4>Returns</h4>
<p> TRUE if preferences are set to export the comment.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-export-exif"></a><h3>gimp_export_exif ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_export_exif (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns whether file plug-ins should default to exporting Exif
metadata, according preferences (original settings is <code class="literal">FALSE</code> since
metadata can contain sensitive information).</p>
<div class="refsect3">
<a name="gimp-export-exif.returns"></a><h4>Returns</h4>
<p> TRUE if preferences are set to export Exif.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-export-xmp"></a><h3>gimp_export_xmp ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_export_xmp (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns whether file plug-ins should default to exporting XMP
metadata, according preferences (original settings is <code class="literal">FALSE</code> since
metadata can contain sensitive information).</p>
<div class="refsect3">
<a name="gimp-export-xmp.returns"></a><h4>Returns</h4>
<p> TRUE if preferences are set to export XMP.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-export-iptc"></a><h3>gimp_export_iptc ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_export_iptc (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns whether file plug-ins should default to exporting IPTC
metadata, according preferences (original settings is <code class="literal">FALSE</code> since
metadata can contain sensitive information).</p>
<div class="refsect3">
<a name="gimp-export-iptc.returns"></a><h4>Returns</h4>
<p> TRUE if preferences are set to export IPTC.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-check-size"></a><h3>gimp_check_size ()</h3>
<pre class="programlisting"><a href="../html/libgimpbase3-gimpbaseenums.html#GimpCheckSize"><span class="returnvalue">GimpCheckSize</span></a>
gimp_check_size (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the size of the checkerboard to be used in previews.</p>
<p>This is a constant value given at plug-in configuration time.</p>
<div class="refsect3">
<a name="gimp-check-size.returns"></a><h4>Returns</h4>
<p> the check_size value</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-check-type"></a><h3>gimp_check_type ()</h3>
<pre class="programlisting"><a href="../html/libgimpbase3-gimpbaseenums.html#GimpCheckType"><span class="returnvalue">GimpCheckType</span></a>
gimp_check_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the type of the checkerboard to be used in previews.</p>
<p>This is a constant value given at plug-in configuration time.</p>
<div class="refsect3">
<a name="gimp-check-type.returns"></a><h4>Returns</h4>
<p> the check_type value</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-default-display"></a><h3>gimp_default_display ()</h3>
<pre class="programlisting"><a class="link" href="GimpDisplay.html" title="gimpdisplay"><span class="returnvalue">GimpDisplay</span></a> *
gimp_default_display (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the default display ID. This corresponds to the display the
running procedure's menu entry was invoked from.</p>
<p>This is a constant value given at plug-in configuration time.</p>
<div class="refsect3">
<a name="gimp-default-display.returns"></a><h4>Returns</h4>
<p>the default display ID
The object belongs to libgimp and you should not free it. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-wm-class"></a><h3>gimp_wm_class ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gimp_wm_class (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the window manager class to be used for plug-in windows.</p>
<p>This is a constant value given at plug-in configuration time.</p>
<div class="refsect3">
<a name="gimp-wm-class.returns"></a><h4>Returns</h4>
<p> the window manager class</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-display-name"></a><h3>gimp_display_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gimp_display_name (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the display to be used for plug-in windows.</p>
<p>This is a constant value given at plug-in configuration time.
Will return <code class="literal">NULL</code> if GIMP has been started with no GUI, either
via "--no-interface" flag, or a console build.</p>
<div class="refsect3">
<a name="gimp-display-name.returns"></a><h4>Returns</h4>
<p> the display name</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-monitor-number"></a><h3>gimp_monitor_number ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
gimp_monitor_number (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the monitor number to be used for plug-in windows.</p>
<p>This is a constant value given at plug-in configuration time.</p>
<div class="refsect3">
<a name="gimp-monitor-number.returns"></a><h4>Returns</h4>
<p> the monitor number</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-user-time"></a><h3>gimp_user_time ()</h3>
<pre class="programlisting"><span class="returnvalue">guint32</span>
gimp_user_time (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the timestamp of the user interaction that should be set on
the plug-in window. This is handled transparently, plug-in authors
do not have to care about it.</p>
<p>This is a constant value given at plug-in configuration time.</p>
<div class="refsect3">
<a name="gimp-user-time.returns"></a><h4>Returns</h4>
<p> timestamp for plug-in window</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-6.html#api-index-2.6">2.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-icon-theme-dir"></a><h3>gimp_icon_theme_dir ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gimp_icon_theme_dir (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-get-progname"></a><h3>gimp_get_progname ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gimp_get_progname (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the plug-in's executable name.</p>
<div class="refsect3">
<a name="gimp-get-progname.returns"></a><h4>Returns</h4>
<p> the executable name</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-version"></a><h3>gimp_version ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gimp_version (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the host GIMP version.</p>
<p>This procedure returns the version number of the currently running
GIMP.</p>
<div class="refsect3">
<a name="gimp-version.returns"></a><h4>Returns</h4>
<p>GIMP version number.
The returned value must be freed with <code class="function">g_free()</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-getpid"></a><h3>gimp_getpid ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
gimp_getpid (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the PID of the host GIMP process.</p>
<p>This procedure returns the process ID of the currently running GIMP.</p>
<div class="refsect3">
<a name="gimp-getpid.returns"></a><h4>Returns</h4>
<p> The PID.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-attach-parasite"></a><h3>gimp_attach_parasite ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_attach_parasite (<em class="parameter"><code>const <a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-GimpParasite.html#GimpParasite"><span class="type">GimpParasite</span></a> *parasite</code></em>);</pre>
<p>Add a global parasite.</p>
<p>This procedure attaches a global parasite. It has no return values.</p>
<div class="refsect3">
<a name="gimp-attach-parasite.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>parasite</p></td>
<td class="parameter_description"><p>The parasite to attach.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-attach-parasite.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-detach-parasite"></a><h3>gimp_detach_parasite ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_detach_parasite (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Removes a global parasite.</p>
<p>This procedure detaches a global parasite from. It has no return
values.</p>
<div class="refsect3">
<a name="gimp-detach-parasite.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The name of the parasite to detach.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-detach-parasite.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-get-parasite"></a><h3>gimp_get_parasite ()</h3>
<pre class="programlisting"><a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-GimpParasite.html#GimpParasite"><span class="returnvalue">GimpParasite</span></a> *
gimp_get_parasite (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Look up a global parasite.</p>
<p>Finds and returns the global parasite that was previously attached.</p>
<div class="refsect3">
<a name="gimp-get-parasite.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The name of the parasite to find.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-get-parasite.returns"></a><h4>Returns</h4>
<p>The found parasite. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-get-parasite-list"></a><h3>gimp_get_parasite_list ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> **
gimp_get_parasite_list (<em class="parameter"><code><span class="type">gint</span> *num_parasites</code></em>);</pre>
<p>List all parasites.</p>
<p>Returns a list of all currently attached global parasites.</p>
<div class="refsect3">
<a name="gimp-get-parasite-list.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>num_parasites</p></td>
<td class="parameter_description"><p>The number of attached parasites. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-get-parasite-list.returns"></a><h4>Returns</h4>
<p>The names of currently attached parasites.
The returned value must be freed with <code class="function">g_strfreev()</code>. </p>
<p><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_parasites][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar*][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-temp-file"></a><h3>gimp_temp_file ()</h3>
<pre class="programlisting"><span class="returnvalue">GFile</span> *
gimp_temp_file (<em class="parameter"><code>const <span class="type">gchar</span> *extension</code></em>);</pre>
<p>Generates a unique temporary file.</p>
<p>Generates a unique file using the temp path supplied in the user's
gimprc.</p>
<div class="refsect3">
<a name="gimp-temp-file.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>extension</p></td>
<td class="parameter_description"><p>The extension the file will have.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-temp-file.returns"></a><h4>Returns</h4>
<p>The new temp file. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libgimp3-Gimp.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="gimp-get-data"></a><h3>gimp_get_data</h3>
<pre class="programlisting">#define gimp_get_data      gimp_pdb_get_data
</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-get-data-size"></a><h3>gimp_get_data_size</h3>
<pre class="programlisting">#define gimp_get_data_size gimp_pdb_get_data_size
</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-set-data"></a><h3>gimp_set_data</h3>
<pre class="programlisting">#define gimp_set_data      gimp_pdb_set_data
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GimpPixbufTransparency"></a><h3>enum GimpPixbufTransparency</h3>
<p>How to deal with transparency when creating thubnail pixbufs from
images and drawables.</p>
<div class="refsect3">
<a name="GimpPixbufTransparency.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GIMP-PIXBUF-KEEP-ALPHA:CAPS"></a>GIMP_PIXBUF_KEEP_ALPHA</p></td>
<td class="enum_member_description">
<p>Create a pixbuf with alpha</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GIMP-PIXBUF-SMALL-CHECKS:CAPS"></a>GIMP_PIXBUF_SMALL_CHECKS</p></td>
<td class="enum_member_description">
<p>Show transparency as small checks</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GIMP-PIXBUF-LARGE-CHECKS:CAPS"></a>GIMP_PIXBUF_LARGE_CHECKS</p></td>
<td class="enum_member_description">
<p>Show transparency as large checks</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>